Get User Onboarding Status

GET apps/api/user/onboarding

You can find the user onboarding status and KYC URL by calling this API with the user's phone number. It can be used to check if the user is verified and, if not, to get the KYC URL to complete the verification process.

The seller receives an SMS with a KYC link automatically on contract creation, but you can also proactively check the user's onboarding status.

Headers:

• Authorization: Bearer {access_token} — Replace {access_token} with the token obtained from Step 1.
• Content-Type: application/json

Field Descriptions

Field Name	Type	Description	Required / Notes / Example
phoneNumber	string	User phone number	Required

Example Request (cURL)

curl --location 'https://api.wepay.com.sa/apps/api/user/onboarding?phoneNumber=966583944450' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Example Response

{
    "data": {
        "platformRefId": "USR_123456",
        "onboarding": 
        {
            "url": "https://integration.wepay-sa.com/kyc?isVerified=true&isKycCompleted=false
                    &isBankAccountReady=true&callbackUrl=https://your-callback-url.com&token=encodedToken",
            "token": "encodedToken",
            "expiresAt": "2024-06-30T10:27:39.889Z"
        },
        "onboardingCompleted": false,
        "isVerified": false,
        "kycCompleted": false,
        "isBankAccountReady": false,
        "isWelcome": false
    },
    "message": "OnboardingRetrievedSuccessfully",
    "status": 200,
    "validationErrors": []
}

Response Fields:

Field	Type	Description
platformRefId	string	Unique identifier for the user in the WePay system
onboarding	Object	An object containing the KYC verification URL and related information
onboardingCompleted	boolean	Whether the user has completed onboarding
isVerified	boolean	Whether the user is Absher verified
kycCompleted	boolean	Whether the KYC process is fully completed
isBankAccountReady	boolean	Whether the user has a ready bank account

Onboarding

Field Name	Type	Description
url	string	redirect URL to complete KYC
token	string	encodedToken
expiresAt	datetime	token expiration time

note

On contract creation, the seller automatically receives an SMS with a KYC link to verify their identity.